/**
 * @file tiny_mailbox.h
 * @author 张恒宣 
 * @LastEditTime 2024/9/21
 * 
 * MIT License
 *
 * Copyright (c) 2025 张恒宣 luckkeymail@163.com
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef __TINY_MAILBOX_H__
#define __TINY_MAILBOX_H__

/*********************
 *       头文件
 *********************/

#include "tiny_queue_plus.h"

/**********************
 *      类型定义
 **********************/

typedef tiny_queue_plus_t *tiny_mailbox_t;

/**********************
 *      函数声明
 **********************/

tiny_mailbox_t tiny_mailbox_create(tiny_uint32_t size);
void tiny_mailbox_release(tiny_mailbox_t mailbox);
QUEUE_RET_STATUS tiny_mailbox_send(tiny_mailbox_t mailbox, tiny_uint64_t data, tiny_int32_t timeout);
QUEUE_RET_STATUS tiny_mailbox_receive(tiny_mailbox_t mailbox, tiny_uint64_t *data, tiny_int32_t timeout);
QUEUE_RET_STATUS tiny_mailbox_send_irq(tiny_mailbox_t mailbox, tiny_uint64_t data, tiny_ret_status_t *is_shcduled);
QUEUE_RET_STATUS tiny_mailbox_receive_irq(tiny_mailbox_t mailbox, tiny_uint64_t *data, tiny_ret_status_t *is_shcduled);

#endif //! __TINY_MAILBOX_H__
